home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / hyper18.zip / HYPER18.DOC < prev    next >
Text File  |  1991-05-12  |  52KB  |  1,717 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.          █    █                               █▀▄ ▄▀█          ▀  █
  14.          █▄▄▄▄█ █    █ █▀▀▀▀█ █▀▀▀▀▀█ █ ▄▀▀▀  █  █  █  ▀▀▀▀▀█  █  █
  15.          █    █ █    █ █    █ █▄▄▄▄▄█ █▀      █     █ █▀▀▀▀▀█  █  █
  16.          █    █ █▄▄▄▄█ █▄▄▄▄█ █▄▄▄▄▄  █       █     █ █▄▄▄▄▄█  █  █
  17.                      █ █
  18.                   ▀▀▀▀ ▀
  19.  
  20.                                CMI HyperMail
  21.  
  22.                 Copyright (c) 1989, 1990 Code Masters, Inc.
  23.  
  24.                                 Version 1.8 GR
  25.  
  26.                                  !Shareware!
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60. __________________________________________________________________________
  61.                                                    HyperMail Documentation
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68. CMI HyperMail Documentation
  69. Version 1.8 GR (General Release) !ShareWare!
  70.  
  71.  
  72. Documentation Outline
  73.  
  74. 1.0.0  Introduction
  75. 1.1.0  About the HyperMail concept
  76. 1.2.0  High level system overview
  77. 1.3.0  Maintenance and Housekeeping
  78.  
  79. 2.0.0  Installation
  80. 2.1.0  Information required prior to installation
  81. 2.2.0  Where to put files
  82. 2.3.0  Running the install program
  83. 2.4.0  What install does
  84.  
  85. 3.0.0   System Configuration Files
  86. 3.1.0   NETMAIL.CNF
  87. 3.2.0   Conference Request File
  88. 3.3.0   LOCK Files
  89.  
  90. 4.0.0   Programs/Parameter Reference
  91. 4.1.0   System Programs
  92. 4.1.1   MSGUTIL.EXE
  93. 4.1.2   UPDATE.EXE
  94. 4.1.3   LINEMAN.EXE
  95. 4.1.4   MAKESYS.EXE
  96. 4.1.5   HUBUTIL.EXE
  97. 4.1.8   COMPLETE.EXE
  98. 4.1.9   NODECOMM.EXE
  99. 4.1.10  HUBCOMM.EXE
  100. 4.1.11  PACKAGE.EXE
  101. 4.1.12  READSYS.EXE
  102.  
  103. 4.2.0   HyperMail Utility Programs
  104. 4.2.1   REWIND.EXE
  105. 4.2.2   DUMPMSG.EXE
  106. 4.2.3   DUMPSYS.EXE
  107. 4.2.4   TRIMCRC.EXE
  108. 4.2.5   Section Not Included
  109. 4.2.6   DELAY.EXE
  110. 4.2.7   REGISTER.EXE
  111. 4.2.8   STRIP.EXE
  112. 4.2.9   Section Not Included
  113. 4.2.10  INSTALL.EXE
  114.  
  115. 4.3.0   WAM Format System Programs
  116. 4.3.1   NETUTIL.EXE
  117. 4.3.2   PCB2WAM.EXE
  118. 4.3.3   ADDCRC.EXE
  119.  
  120. 5.0.0   System Batch File Reference
  121. 5.1.0   EV_NODE.BAT
  122. 5.2.0   EV_HUB.BAT
  123. 5.3.0   DC_NODE.BAT
  124. 5.4.0   DC_HUB.BAT
  125. 5.5.0   AC_HUB.BAT  (AC_NODE1.BAT and AC_NODE2.BAT see Appendix D)
  126. 5.6.0   CALLSEND.BAT
  127. 5.7.0   BUILD.BAT
  128. 5.8.0   PACKET.BAT
  129.  
  130.                  (c) 1989, 1990, 1991 by Code Masters, Inc.
  131.                                  - Page 1 -
  132.  
  133.  
  134. CMI HyperMail Documentation
  135. Version 1.8 GR (General Release) !ShareWare!
  136.  
  137.  
  138. 6.0.0   System Control File Reference
  139. 6.1.0   NETMAIL.SYS
  140. 6.2.0   NETMAIL.LOG
  141. 6.3.0   $SYSTEM$.PWD
  142. 6.4.0   $EMAIL and $EMAIL.NDX
  143. 6.5.0   CRC and CRC.IX
  144. 6.6.0   SystemId.SYS
  145.  
  146. 7.0.0   Environment Variables
  147. 7.1.0   LOGFILE=
  148. 7.2.0   SYSTEM=
  149. 7.3.0   CONFIG=
  150. 7.4.0   BAUD=
  151.  
  152. 8.0.0   Required third party programs
  153. 8.1.0   DSZ
  154. 8.2.0   PKZIP
  155.  
  156. 9.0.0   Conclusion
  157. 9.1.0   Registration Information
  158. 9.2.0   Disclaimer
  159. 9.3.0   Where to get more information
  160.  
  161. Appendix A - Example: Steps to set up a 3 node network.
  162.  
  163. Appendix B - Using PCBoard as a front end.
  164.  
  165. Appendix C - Upgrading from a previous version of HyperMail
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.                  (c) 1989, 1990, 1991 by Code Masters, Inc.
  197.                                  - Page 2 -
  198.  
  199.  
  200. CMI HyperMail Documentation
  201. Version 1.8 GR (General Release) !ShareWare!
  202.  
  203. 1.0.0   Introduction
  204.  
  205. One of the increasingly popular avenues BBS enthusiasts are taking their
  206. systems into is Electronic Mail Networks.  As the popularity of these
  207. networks increases, so does the variety of network products.  Each network
  208. software package has its own blend of distinguishing features designed by
  209. its authors.  The HyperMail Network System has been created with a variety
  210. of unique features that deliver it to the cutting edge of BBS Electronic
  211. Mail Networking. The HyperMail System is designed to be easy to install by
  212. novice system operators and yet it packs state of the art features that
  213. experienced system operators require.
  214.  
  215. The HyperMail Network System is configured to work with PCBoard 14.x
  216. compatible messages bases.  It is not required that your use PCBoard to run
  217. HyperMail.  Other software packages such as PassKey, WBBS and WildCat are
  218. 'interface-able' with HyperMail.  Consult the Wide Area Message Format
  219. section of the manual for more information.  As translators become
  220. available for more systems, HyperMail will grow to be a valued tool for
  221. your networking needs.
  222.  
  223. The HyperMail Electronic Mail Network System provides the following
  224. features:
  225.  
  226.              * Easy to use installation tool
  227.  
  228.              * Completely self contained communications modules (no
  229.                complicated and unreliable communications program scripts to
  230.                write)
  231.  
  232.              * High speed message processing system
  233.  
  234.              * CRC checking of all messages - Absolutely NO duplicate
  235.                messages!
  236.  
  237.              * Optional suppression of TAG lines
  238.  
  239.              * Shareware!  No need to spend money before your network is
  240.                operational.
  241.  
  242.              * Too many more features to mention...
  243.  
  244. 1.1.0   About the HyperMail Concept
  245.  
  246. The installation tool provided in the HyperMail software package
  247. will completely install and configure the HyperMail network system on
  248. a Node in under 20 minutes (slightly less time is required for Hub
  249. configuration).  The HyperMail installation tool provides context sensitive
  250. help and complete checking for all configuration information.  When all of
  251. the necessary information has been entered into the configuration utility,
  252. the installation tool will create all necessary batch files and
  253. configuration files, allowing the system operator to begin processing mail
  254. after only a few more steps.
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.                  (c) 1989, 1990, 1991 by Code Masters, Inc.
  263.                                  - Page 3 -
  264.  
  265.  
  266. CMI HyperMail Documentation
  267. Version 1.8 GR (General Release) !ShareWare!
  268.  
  269. One of the most unique features of the HyperMail software package is the
  270. communications modules.  HyperMail does not rely on complicated and
  271. unreliable script files and confusing modem programs. The HUBComm and
  272. NODEComm modules of HyperMail have been designed specifically to transfer
  273. mail fast and reliably without requiring constant system operator
  274. supervision.
  275.  
  276. Because of HyperMail's ease of installation and maintenance free operation,
  277. the system operator is free to spend his time on other, more enjoyable
  278. tasks.  Thank you for selecting HyperMail as your network software of
  279. choice.
  280.  
  281.  
  282. 1.2.0   High Level System Overview
  283.  
  284. Node:
  285. The following describes the steps a HyperMail Node completes to transfer
  286. mail with the Hub(s) it is attached to:
  287.  
  288.     1> The Node software checks all HyperMail designated conferences for
  289.        outbound messages and extracts copies of them to a temporary file.
  290.  
  291.     2> The Node then dials the phone number of its Hub. The Hub software
  292.        receiving the call picks up the phone and connection is established.
  293.  
  294.     3> The Node and corresponding Hub exchange system Id and password
  295.        information. This step provides identification of individual nodes
  296.        and complete mail security.
  297.  
  298.     4> The Node sends any outbound messages to the Hub system it is
  299.        currently attached to. It also transfers an updated list of message
  300.        areas the system is currently accepting messages for.
  301.  
  302.     5> After receiving the message package from the node, the hub transfers
  303.        any messages addressed to the currently connected node.
  304.  
  305.     6> All of the messages have been exchanged at this point, so the
  306.        communication link is disconnected.
  307.  
  308.     7> The Node software processes any messages that it has received,
  309.        places them in their designated message areas and cleans up
  310.        remaining temporary files.
  311.  
  312. 1.3.0   Maintenance and Housekeeping
  313.  
  314. 2.0.0   Installation
  315.  
  316. A typical HyperMail software installation takes less than 20 minutes for a
  317. novice user.  If an error occurs during installation the process can be
  318. repeated as necessary.  Multiple installations will no affect system
  319. performance.
  320.  
  321. 2.1.0   Information required prior to installation
  322.  
  323.     * System Id - Choose a System Id for the node.  This can be any
  324.       combination of 8 numbers or letters.  The System Id is used to
  325.       identify each individual HyperMail system for proper connection and
  326.       mail transfer. This System Id should be descriptive of the BBS.
  327.  
  328.                  (c) 1989, 1990, 1991 by Code Masters, Inc.
  329.                                  - Page 4 -
  330.  
  331.  
  332. CMI HyperMail Documentation
  333. Version 1.8 GR (General Release) !ShareWare!
  334.  
  335.       Because it is used to create DOS files, the system ID is limited to
  336.       characters that are valid in DOS file names.
  337.  
  338.     * BBS Drive Letter and Directory Name - The DOS directory that contains
  339.       all of the software and configuration files for your BBS.
  340.  
  341.     * Command Line used to start your BBS - The name of the batch file you
  342.       use to start your BBS (ie. BOARD.BAT).
  343.  
  344.     * Type of Message Information file you will be using.  As of vesion
  345.       1.72 of HyperMail, the system will support either the ProDoor
  346.       CONFINFO file format or the PCBoard 14.5 CNAMES.@@@ file format.  If
  347.       you are running a PCBoard version less than 14.5 you must use a
  348.       ProDOOR CONFINFO file.
  349.  
  350.     * The number of the communications port your modem is attached to (ie.
  351.       COM1 or COM2). Note: HyperMail only supports ComPorts 1 thru 2.
  352.  
  353.     * What type of modem your have:
  354.  
  355.         D - USR Dual Standard (Full duplex at V.32 9600);
  356.         H - Half Duplex at high speeds (HST HST1440 modes)
  357.         F - Full Duplex always (Standard 1200, 2400 modems)
  358.  
  359.     * The maximum BPS rate your modem will accept - This is the highest
  360.       speed your modem is capable of using to communicate with the
  361.       computer.  Note: This number must be 19200 or less if you do not have
  362.       a 16550 UART communications chip installed in your computer. The
  363.       installation utility will check for this and will not allow you to
  364.       use an improper value.
  365.  
  366.     * The System ID of the HUB your system will be calling to exchange
  367.       mail (for Node configuration only) - Most systems attached to an
  368.       Electronic Mail Network need to place at least one phone call to
  369.       exchange mail. With HyperMail, this call must be placed to a system
  370.       running the HyperMail Software. Before you can properly exchange mail
  371.       with a HyperMail Hub, it is necessary to have its system id.
  372.       To obtain information regarding BBSs currently running HyperMail HUB
  373.       software, please see the WHERE TO GET MORE INFORMATION section of the
  374.       manual.
  375.  
  376.     * The Phone Number of the HUB your system will be calling to exchange
  377.       mail (for Node configuration only).
  378.  
  379. 2.2.0   Where to put the files
  380.  
  381. Once you have all of the information necessary to begin the installation,
  382. you must create a DOS subdirectory on your hard disk specifically for the
  383. use of HyperMail. Once this is done, copy all of the files included with
  384. your HyperMail package into this directory.
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.                  (c) 1989, 1990, 1991 by Code Masters, Inc.
  395.                                  - Page 5 -
  396.  
  397.  
  398. CMI HyperMail Documentation
  399. Version 1.8 GR (General Release) !ShareWare!
  400.  
  401. 2.3.0   Running the Installation Tool
  402.  
  403. After creating a subdirectory for the HyperMail software and moving all of
  404. the HyperMail files into it, it is necessary to run the Installation Tool.
  405. Begin by changing the current directory to the newly created HyperMail
  406. directory. Next type:
  407.  
  408.                         INSTALL
  409.  
  410. and press <RETURN> from the DOS prompt.
  411.  
  412. This will execute the Installation Tool and allow you to enter all of the
  413. necessary information. The Installation program has built in context
  414. sensitive help. You can press the <F1> key on your keyboard at any prompt
  415. to see more information about the current question.
  416.  
  417. The installation program requires a system information file called
  418. REGISTER.DOC.  This file contains your registration information.
  419. If this file is missing Install will not operate.  If you know your
  420. registration number and registration name, you can execute the REGISTER.EXE
  421. program to create a REGISTER.DOC file.
  422.  
  423. 2.4.0 What the Installation Tool does
  424.  
  425. The HyperMail Installation Tool performs a majority of the tasks necessary
  426. for proper installation of the HyperMail Software Package. This includes:
  427.  
  428.          * Creates all of the Batch files necessary for operation.  All of
  429.            the batch files created are custom and base on information
  430.            entered in the Installation Tool.
  431.  
  432.          * Writes the NETMAIL.CNF file. NETMAIL.CNF is the main
  433.            configuration file used by most of the programs in the HyperMail
  434.            system. This file is described in depth in the SYSTEM
  435.            CONFIGURATION FILES section of this manual.
  436.  
  437.          * Runs the UPDATE utility. This utility creates a pointer file
  438.            that is used to reference your BBS message bases. This file must
  439.            be created before your system is able to properly process mail.
  440.            The UPDATE program is explained in depth in the SYSTEM PROGRAMS
  441.            REFERENCE section of this manual.
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.                  (c) 1989, 1990, 1991 by Code Masters, Inc.
  461.                                  - Page 6 -
  462.  
  463.  
  464. CMI HyperMail Documentation
  465. Version 1.8 GR (General Release) !ShareWare!
  466.  
  467. 3.0.0   System Configuration Files
  468.  
  469. 3.1.0   NETMAIL.CNF
  470.  
  471. The NETMAIL.CNF file is the main configuration file.  This file is used by
  472. almost all of the programs included in the HyperMail software package.
  473. This file is a text file and can be edited by most text editors (ie. DOS
  474. EDLIN, QEdit, etc.).  The following is an example NETMAIL.CNF file:
  475.  
  476. VERSION 1.71                            ; Version Information
  477. HyperLink Administration                ; Registration Name
  478. 0000                                    ; Registration Number
  479. NONE                                    ; Comment on Messages
  480. C:\PCB                                  ; BBS System Directory
  481. C:\PCB\MAIN\CNAMES.@@@ /CNAMES          ; Path and Name of Conference File
  482. 1                                       ; Com Port
  483. 9600                                    ; Maximum BPS open rate
  484. ATX4M0H0                                ; Modem Init String
  485. YES                                     ; Echo Private Mail
  486. ANDY WOODWARD                           ; Sysop Name
  487. (602)888-8888                           ; Voice Phone Number
  488. (602)838-7738                           ; Data Phone Number
  489. 1 Any Street                            ; Street Address
  490. Phoenix                                 ; City
  491. AZ                                      ; State
  492. 85000                                   ; ZipCode
  493. 0                                       ; Greenwich Mean Time Factor
  494. ; Node List Comment (60 chars max!)
  495. This is a comment for the Node List.
  496.  
  497. Any information that appears after a semicolon in the NETMAIL.CNF file is
  498. not used by the HyperMail System and may be used as comment areas.
  499.  
  500. The registration name and registration number are provided with your
  501. original software package in a file called REGISTER.DOC. If you do not have
  502. a REGISTER.DOC file but you know your registration name and number. You may
  503. create a REGISTER.DOC file by using the REGISTER.EXE utility (included with
  504. the HyperMail Software Package).
  505.  
  506.  
  507.  
  508.  
  509.  
  510.  
  511.  
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.                  (c) 1989, 1990, 1991 by Code Masters, Inc.
  527.                                  - Page 7 -
  528.  
  529.  
  530. CMI HyperMail Documentation
  531. Version 1.8 GR (General Release) !ShareWare!
  532.  
  533. 3.2.0   Conference Request File
  534.  
  535. Every node must create a conference request file.  The conference request
  536. file is used to request conferences from the attached hub.  The request
  537. file also specifies where these message areas are to be directed.
  538.  
  539.      1> PASSWORD
  540.      2> 3  10
  541.      3> 7  6
  542.      4> 22 7
  543.      5> 9  8
  544.      6> 5  5
  545.  
  546.      Line 1: Your Password for the Hub
  547.      Line 2: The conference conversions:
  548.  
  549.          The left side lists the node conference numbers, the right
  550.          side is the Hubs conference numbers.  You are
  551.          requesting the Hub conferences which will be placed
  552.          in your node conferences.
  553.  
  554. As in the example:
  555.          Hub Area 10 is directed to your area 3
  556.          Hub Area 6  is directed to your area 7
  557.          Hub Area 7  is directed to your area 22
  558.          Hub Area 8  is directed to your area 9
  559.          Hub Area 5  is directed to your area 5
  560.  
  561. There can be a maximum of 255 conference requests. Note: it is not possible
  562. to direct messages from more than one conference into a specific
  563. conference. The following example is not possible with HyperMail:
  564.  
  565.              PASSWORD
  566.              5  6
  567.              22 6
  568.  
  569. Be sure and check your conference table to make sure this does not happen.
  570.  
  571.  
  572. 3.3.0   LOCK Files
  573.  
  574. For every node connected, the system operator can include in the
  575. HyperMail directory a file named SystemId.LOK, where the SystemId is the
  576. name of node attached to you.  The *.LOK file is a text file in the format
  577. of:
  578.  
  579. Cnum;Cnum;Cnum-Cnum;Cnum;Cnum-Cnum
  580.  
  581. where you specify conferences to 'Lock' in a sequence similar to how the
  582. REWIND.EXE program functions.
  583.  
  584. The *.LOK files restrict a node's access to the conferences listed in the
  585. SystemId.LOK file.  A node may request a message base listed in his
  586. SystemId.LOK file, but no messages will be extracted.  The Lock function
  587. does not affect insertion.
  588.  
  589. The Hub system operator may also create a file called _GLOBAL_.LOK, which
  590. is another .LOK file, but is active for ALL nodes.
  591.  
  592.                  (c) 1989, 1990, 1991 by Code Masters, Inc.
  593.                                  - Page 8 -
  594.  
  595.  
  596. CMI HyperMail Documentation
  597. Version 1.8 GR (General Release) !ShareWare!
  598.  
  599.  
  600. NOTE:  If an entry exists for a specific conference in a SystemId.LOK file
  601. AND in the _GLOBAL_.LOK file the entry is toggled (i.e. that node will be
  602. able to request that conference).
  603.  
  604. 4.0.0   Programs/Parameter Reference
  605.  
  606. 4.1.0   HyperMail System Programs
  607.   This section is a reference to the functionality and command line
  608.   parameters for the HyperMail System Programs.
  609.  
  610. 4.1.1   MSGUTIL.EXE Parameters
  611.   Description: This program controls access to all message areas.
  612.  
  613.   Parameters:
  614.   /EXTRACT - Extract new messages
  615.  
  616.   /INSERT - Insert received messages
  617.  
  618.   /BUILD - Build packets for nodes.  This is only for hub operation.  The
  619.   build operation extracts new messages for every node attached to the hub.
  620.  
  621.   /DISABLE_OUTPUT - Do not write a NETMAIL.MSG file.  This parameter is
  622.   only valid with use of the /EXTRACT parameter.
  623.  
  624.   /ECHO - Echo ALL messages regardless of message echo flag.  This
  625.   parameter is only valid with use of the /EXTRACT parameter.  This
  626.   parameter is necessary other network programs turn off the message echo
  627.   flags.
  628.  
  629.   /DAYS:NumDays - Limit inserted messages to NumDays.  Messages that are
  630.   less than or equal to Numdays old will be inserted.  This parameter is
  631.   only valid with use of the /INSERT parameter.
  632.  
  633.   /NOSCREEN - Do not write verbose messages to the screen.
  634.  
  635.   /DISABLELOG - Do not write logging information to the NETMAIL.LOG file.
  636.   It is not recommended that this parameter be used.
  637.  
  638.   /NOTAG - Do not include HyperMail tag lines.
  639.  
  640.   Notes:
  641.   Parameters may be in any order.  /EXTRACT or /INSERT or /BUILD must be
  642.   present somewhere on the command line.  The other parameters are not
  643.   required.
  644.  
  645.   Example:
  646.  
  647.     MSGUTIL.EXE /E /ECHO /NOSCREEN
  648.  
  649.     This causes the program to operate in 'Extract' mode.  MSGUTIL.EXE will
  650.     echo ALL messages regardless of the individual message echo flag and
  651.     will not write messages to the screen.
  652.  
  653.  
  654.  
  655.  
  656.  
  657.  
  658.                  (c) 1989, 1990, 1991 by Code Masters, Inc.
  659.                                  - Page 9 -
  660.  
  661.  
  662. CMI HyperMail Documentation
  663. Version 1.8 GR (General Release) !ShareWare!
  664.  
  665. 4.1.2   UPDATE.EXE
  666.   Description:   The UPDATE.EXE reads the NETMAIL.SYS file and updates the
  667.   pointer file (SystemId.PTR) bases on the remote system specified in the
  668.   NETMAIL.SYS file. UPDATE.EXE positions the message pointers to the high
  669.   message number of each message area and rewrites the (SystemId.PTR) file.
  670.  
  671. 4.1.3   LINEMAN.EXE Parameter ComPort
  672.   Description: This program controls the data link between the remote and
  673.   the host systems.
  674.   Parameters:
  675.   H        <- Hold the data link
  676.   R        <- Release the data link
  677.   O        <- Disconnect data link
  678.  
  679.   Example:
  680.  
  681.     LINEMAN 1 O
  682.  
  683.     The datalink on com port 1 will be disconnected.
  684.  
  685. 4.1.4   MAKESYS.EXE LocalId [RemoteId PhoneNumber] [Protocol] [Function]
  686.   Description: The program creates the system control file used by the
  687.   HyperMail system.  The default name for the system control file is
  688.   NETMAIL.SYS.  The default name can be changed by using an environment
  689.   variable.  The control file holds general information used by most every
  690.   program in the system.
  691.  
  692.   Parameters:
  693.  
  694.   LocalId - Specify your system id, the 8 letter identifier that was
  695.   assigned to your system.  For example: CIS or TECHNOID.  This is the only
  696.   parameter needed if the local system is acting like a hub or receiving
  697.   calls.
  698.  
  699.   The following parameters are required when the local system is attempting
  700.   to connect with a hub or place a call:
  701.  
  702.   RemoteSystemId - Specify the remote id for which a session is to be
  703.   established.
  704.  
  705.   PhoneNumber - Specify the phone number, including long distance codes if
  706.   any, for the remote system.
  707.  
  708.   Protocol - This parameter selects the protocol for the transfer.  This
  709.   parameter can be a letter from A to Z.  If the parameter is not
  710.   specified, the default is Z for Zmodem.  If a protocol is requested that
  711.   the hub system does not support, both systems will default to Zmodem.
  712.  
  713.   Function - The function parameter specifies with function the systems
  714.   will perform.  The value of the function parameter must be between 1 and
  715.   98.  If no function is specified the default to 0 or normal mail
  716.   processing.
  717.  
  718.  
  719.  
  720.  
  721.  
  722.  
  723.  
  724.                  (c) 1989, 1990, 1991 by Code Masters, Inc.
  725.                                 - Page 10 -
  726.  
  727.  
  728. CMI HyperMail Documentation
  729. Version 1.8 GR (General Release) !ShareWare!
  730.  
  731.   Example:
  732.  
  733.     MAKESYS.EXE CIS TECHNOID 1170,1-602-222-1234
  734.  
  735.     This example creates a system file for use by the node 'CIS'.  CIS will
  736.     be placing a call to TECHNOID.  This will cause MAKESYS.EXE to create a
  737.     system file where the local system id is CIS, the remote system id is
  738.     TECHNOID and the remote phone number is 1170,1-602-222-1234.  The
  739.     protocol will default to Zmodem.  The function will default to 0 or
  740.     normal mail processing.
  741.  
  742.     MAKESYS.EXE TECHNOID
  743.  
  744.     This example creates a system file for use when system 'TECHNOID' is
  745.     acting like a hub or receiving calls.
  746.  
  747. 4.1.5   HUBUTIL.EXE
  748.   Description: HubUtil contains a collection of functions used internally
  749.   by the HyperMail system.  These parameters are provided as a reference
  750.   only.
  751.  
  752.   Parameters:
  753.   /PASSWORD - Copies the SystemId.NEW to ConnectId.NOD
  754.   /NAME - Renames ConnectId.ZIP to NODE.ZIP
  755.   /RENAME - Renames NODE.ZIP to ConnectId.ZIP
  756.   /DELETE - Purges ConnectId.SYS
  757.   /EXTRACT - Renames NETMAIL.MSG to ConnectId.MSG
  758.  
  759. 4.1.8   COMPLETE.EXE
  760.   Description: This program logs a completed mail transfer session to a log
  761.   file called COMPLETE.LOG.
  762.  
  763. 4.1.9   NODECOMM.EXE TimeOutPeriod [Parameters]
  764.   Description: NODECOMM.EXE is the communications engine used by node
  765.   system for placing calls to hub systems.  NodeComm is the counter part
  766.   for HubComm which runs on the hub system.
  767.  
  768.   Parameters:
  769.  
  770.   TimeOutPeriod - Numeric number between 5 and 999.  Tells NODECOMM.EXE how
  771.   long to try to connect with the remote system in minutes.
  772.  
  773.   /CD - Load on carrier detect (DO NOT hang-up) and do not initialize the
  774.   modem.  Use the /CD parameter when a connection has already been
  775.   established by another program.  NodeComm will not initialize the modem
  776.   or dial the remote system.  This causes NodeComm to proceed to the system
  777.   password handshake phase.
  778.  
  779.   /F:filename - Activate NodeComm for front-end processing.  NodeComm will
  780.   read the first line in the filename and transmit that line every three
  781.   seconds for 15 seconds.  This should allow a front end like ProLogon to
  782.   trigger a mail session.  For example:  ProLogon requires the string  'N
  783.   MAILRUN' to be transmitted in order to trigger a mail process.  See
  784.   Appendix B for further information.
  785.  
  786.  
  787.  
  788.  
  789.  
  790.                  (c) 1989, 1990, 1991 by Code Masters, Inc.
  791.                                 - Page 11 -
  792.  
  793.  
  794. CMI HyperMail Documentation
  795. Version 1.8 GR (General Release) !ShareWare!
  796.  
  797. 4.1.10  HUBCOMM.EXE TimeOutPeriod [Parameters]
  798.   Description: NODECOMM.EXE is the communications engine used by hub system
  799.   to receive calls from node systems.  HubComm is the counter part for
  800.   NodeComm which runs on the node system.
  801.  
  802.   Parameters:
  803.   TimeOutPeriod - Numeric number between 5 and 999.  This configures
  804.   HubComm to wait in answer mode for the TimeOutPeriod.
  805.  
  806.   /CD - Load on carrier detect (DO NOT hang-up) or initialize the modem.
  807.   Use this parameter with a front end program and the AC_HUB.BAT file.
  808.  
  809. 4.1.11  PACKAGE.EXE pkzip.exe $1$ $2$
  810.   Description:  Package adds newly extracted mail packets to an
  811.   existing archive.  The first parameter specifies the compression program
  812.   to use, normally PKZIP.EXE.  The compression program MUST exist on the
  813.   DOS path not in the current directory.  If the path statement is SET
  814.   PATH=C:\TOOLS then PKZIP.EXE must reside in the directory C:\TOOLS.
  815.   The second parameter $1$ is the archive name.  The Third parameter $2$ is
  816.   the file to be added to the archive.  Package shells to the compression
  817.   program and passes the proper parameters by using the $1$ and $2$ for
  818.   placement.  Other parameters may be passed.  Both $1$ and $2$ are
  819.   required to exist on the command line or Package will not function
  820.   properly.
  821.  
  822.   Parameters:
  823.  
  824.   pkzip.exe - the compression program to use.  pkzip.exe is the default
  825.   used by the system.  This parameter may be replaced by other compression
  826.   utilities as they become available.  NOTE:  All systems using HyperMail
  827.   must maintain the same compression standard.  Do not change this
  828.   parameter unless directed by the network administrator.
  829.  
  830.   $1$ - This parameter is replaced by the archive name by Package.
  831.  
  832.   $2$ - This parameter is replaced by the file name to be added to the
  833.   archive.
  834.  
  835.   Notes:
  836.   DO NOT change the parameters to any command line used by PACKAGE.EXE
  837.   unless directed by the network administrator.
  838.  
  839.   Example:
  840.  
  841.     PACKAGE pkzip.exe -a $1$ $2$ extra.doc nodelist.doc
  842.  
  843.     Package with shell to PKZIP.EXE using the command line:
  844.       PKZIP.EXE -A ArchiveName FileToAdd EXTRA.DOC NODELIST.DOC
  845.  
  846.       ArchiveName and FileToAdd will be replaced by Package with the proper
  847.       parameters.  This command line causes PKZIP.EXE to add to the archive
  848.       specified by ArchiveName the files FileToAdd, EXTRA.DOC NODELIST.DOC.
  849.  
  850.  
  851.  
  852.  
  853.  
  854.  
  855.  
  856.                  (c) 1989, 1990, 1991 by Code Masters, Inc.
  857.                                 - Page 12 -
  858.  
  859.  
  860. CMI HyperMail Documentation
  861. Version 1.8 GR (General Release) !ShareWare!
  862.  
  863. 4.1.12  READSYS.EXE
  864.   Description: This program controls batch file execution inside the
  865.   HyperMail system.
  866.  
  867.   Parameters:
  868.   /FUNCTION - Causes ReadSys to halt on an errorlevel corresponding to the
  869.   function parameter in the system control file (NETMAIL.SYS).
  870.  
  871.   /PROTOCOL - Causes ReadSys to halt on an errorlevel corresponding to the
  872.   protocol parameter in the system control file (NETMAIL.SYS).
  873.  
  874.   Example:
  875.  
  876.     READSYS.EXE /FUNCTION
  877.     IF ERRORLEVEL 9 GOTO FUNCTION_9
  878.     IF ERRORLEVLE 8 GOTO FUNCTION_8
  879.  
  880.     READSYS.EXE /PROTOCOL
  881.     IF ERRORLEVEL 26 GOTO ZMODEM_TRANSFER    ( Z is 26th letter in
  882.     alphabet) IF ERRORLEVEL  7 GOTO YMODEM_G_TRANSFER  ( G is 7th letter in
  883.     alphabet)
  884.  
  885. 4.2.0   HyperMail User Utility Programs
  886.  
  887. 4.2.1   REWIND.EXE SystemId AreaList NumberOfMessages
  888.   Description: This program allows system operators to rewind the message
  889.   pointer for a particular message area or a list of messages areas.
  890.  
  891.   Parameters:
  892.   SystemId - The active pointer file for a system.
  893.  
  894.   AreaList - Specifies a list of conferences or a range of conferences to
  895.   be rewound.  A semicolon ';' is an area separator and a '-' is a range
  896.   indicator.  For example: 1-5;8;10;12-15 would rewind messages areas
  897.   1,2,3,4,5,8,10,12,13,14,15.
  898.  
  899.   NumberOfMessages - Specifies how many messages to rewind.  If this value
  900.   is larger than the available message count, the message area in the
  901.   pointer file is rewound to the first message.
  902.  
  903. 4.2.2   DUMPMSG.EXE MessageFileName
  904.   Description: Creates a text file bases on the MessagefileName.  The name
  905.   of the text file is MESSAGES.OUT.
  906.  
  907.   Parameters:
  908.  
  909.   MessageFileName - This is the message base to 'dump' to a text file.  It
  910.   can be a HyperMail packet file (NEMTAIL.MSG MP??????.PKT) or a ProDOOR
  911.   compatible message base.
  912.  
  913. 4.2.3   DUMPSYS.EXE
  914.   Description: Displays the contents of the current system control file.
  915.   Usually this file is named NETMAIL.SYS unless otherwise overridden by an
  916.   environment variable.
  917.  
  918.  
  919.  
  920.  
  921.  
  922.                  (c) 1989, 1990, 1991 by Code Masters, Inc.
  923.                                 - Page 13 -
  924.  
  925.  
  926. CMI HyperMail Documentation
  927. Version 1.8 GR (General Release) !ShareWare!
  928.  
  929. 4.2.4   TRIMCRC.EXE NumberToKeep
  930.   Description: The HyperMail system maintains a CRC data base for all
  931.   inserted and extracted messages for the local system.  On occasion it may
  932.   be necessary to purge older records from this data base as it may be
  933.   large.  Executing TRIMCRC.EXE with no parameters will show the number of
  934.   records currently stored in the data base.
  935.  
  936.   Parameters:
  937.  
  938.   NumberToKeep - Specifies the number of message CRC's to keep.  The system
  939.   will keep the most recent records and purge all old records above the
  940.   NumberToKeep threshold.
  941.  
  942. 4.2.5   Section Not Included
  943.  
  944. 4.2.6   DELAY.EXE NumberOfSeconds
  945.   Description: Causes a count down to take place.
  946.  
  947.   Parameters:
  948.  
  949.   NumberOfSeconds - Number of seconds to count.
  950.  
  951.   Example:
  952.  
  953.     DELAY 8
  954.  
  955.     Delay 8 seconds.
  956.  
  957.  
  958. 4.2.7   REGISTER.EXE
  959.   Description: Creates a REGISTER.DOC file required by INSTALL.EXE.  Given
  960.   the system name text and a serial number, Register will create a
  961.   REGISTER.DOC file for the install program.
  962.  
  963.  
  964. 4.2.8   STRIP.EXE FileSpec [/C] [/T:FileName] [/Text]
  965.   Description:  Strip is a general purpose utility to strip control
  966.   characters (ASCII 1 to ASCII 31) and tag files from ProDOOR compatible
  967.   message bases, HyperMail message files or text files.
  968.  
  969.   Parameters:
  970.  
  971.   FileSpec - Specifies a file name (wild cards ok) to process.  For
  972.   example: STRIP.EXE *.PKT /C would strip all control characters for all
  973.   .PKT files in the current directory.
  974.  
  975.   /C - Strip control characters from message files.  This parameter will
  976.   strip any character between ASCII decimal 1 and ASCII decimal 31.
  977.  
  978.   /T:filename - Causes Strip to read filename into a buffer area and search
  979.   for tag lines  based on the filename entries.
  980.  
  981.  
  982.  
  983.  
  984.  
  985.  
  986.  
  987.  
  988.                  (c) 1989, 1990, 1991 by Code Masters, Inc.
  989.                                 - Page 14 -
  990.  
  991.  
  992. CMI HyperMail Documentation
  993. Version 1.8 GR (General Release) !ShareWare!
  994.  
  995.     filename format - specify a tag file to purge, this is case sensitive!
  996.     For example:
  997.  
  998.     * Via
  999.     * EZ
  1000.  
  1001.     would strip all lines beginning with "* Via" and "* EZ".  Leading
  1002.     spaces are stripped from both the message text and the tag file
  1003.     entries.
  1004.  
  1005.   Notes: An example tag file called TAGFILE.TXT is included in the
  1006.   HyperMail package for further examples.
  1007.  
  1008. 4.2.9  Section Not Included
  1009.  
  1010. 4.2.10  INSTALL.EXE
  1011.   Description: Asks a series of questions and creates the appropriate
  1012.   configuration files and batch files for system operation.  The operation
  1013.   of the system is not affected by multiple installations.
  1014.  
  1015. 4.3.0   WAM Format System Programs
  1016.   These utilities are only used when the HyperMail system is configured
  1017.   with a WAM interface.  Using a WAM interface allows any system to
  1018.   communicate to a HyperMail network.  As more interfaces become available
  1019.   for such systems as FIDO, WildCat, QBBS, WBBS and PassKey, these systems
  1020.   will be able to interface with ANY HyperMail network.
  1021.  
  1022.   The WAM Format is a general purpose textual interface standard for
  1023.   message interchange.  The format is released every quarter with changes
  1024.   and updates.  Consult the file WAM?Q90.ZIP for more information on the
  1025.   WAM Format.
  1026.  
  1027.   Consult HYPERWAM.ZIP for more information on how to interface HyperMail
  1028.   to WAM and ANY BBS to WAM.
  1029.  
  1030. 4.3.1   NETUTIL.EXE
  1031.   Description:  This program is the control center for the HyperWam
  1032.   interface.  It executes WAM interface files EXPORT.EXE, IMPORT.EXE and
  1033.   UPDATE.EXE in the proper sequence.
  1034.  
  1035. 4.3.2   PCB2WAM.EXE
  1036.   Description:  This program converts ProDOOR compatible message bases or
  1037.   HyperMail message files to the WAM Format standard and visa versa.
  1038.   Execute the program to review the command line parameters.
  1039.  
  1040. 4.3.3   ADDCRC.EXE
  1041.   Description:  AddCRC is a utility for the HyperWam interface that adds
  1042.   CRC's to the CRC data base maintained by the HyperMail system.  Consult
  1043.   HyperWam documentation for further reference.
  1044.  
  1045. 5.0.0   System Batch File Reference
  1046.  
  1047. 5.1.0   EV_NODE.BAT
  1048.   Description: This batch file is a replacement for an event file for the
  1049.   node system.  EV_NODE will change to the mail directory as specified by
  1050.   INSTALL.EXE, conduct a mail run, change back to the BBS directory and
  1051.   restart the BBS.  EV_NODE.BAT is for use on Node systems and should be
  1052.   added to or combined with the current event file.
  1053.  
  1054.                  (c) 1989, 1990, 1991 by Code Masters, Inc.
  1055.                                 - Page 15 -
  1056.  
  1057.  
  1058. CMI HyperMail Documentation
  1059. Version 1.8 GR (General Release) !ShareWare!
  1060.  
  1061. 5.2.0   EV_HUB.BAT
  1062.   Description: This batch file is a replacement for an event file for the
  1063.   hub system.  EV_HUB will change to the mail directory as specified by
  1064.   INSTALL.EXE, conduct a mail run, change back to the BBS directory and
  1065.   restart the bbs.  EV_HUB.BAT is for use on Hub systems and should be
  1066.   added to or combined with the current event file.
  1067.  
  1068. 5.3.0   DC_NODE.BAT
  1069.   Description:  This batch file is the workhorse of the HyperMail system
  1070.   for node operation.  It requires several parameters.  EV_NODE.BAT calls
  1071.   this batch file with the proper parameters.  Consult the batch file
  1072.   listing for further information.
  1073.  
  1074. 5.4.0   DC_HUB.BAT
  1075.   Description:  This batch file is the workhorse of the HyperMail system
  1076.   for hub operation.  It requires several parameters.  EV_HUB.BAT calls
  1077.   this batch file with the proper parameters.  Consult the batch file
  1078.   listing for further information.
  1079.  
  1080. 5.5.0   AC_HUB.BAT
  1081.   Description:  This batch file is used in conjunction with a hub system
  1082.   and a front end program like CMIDoor or ProLogon.  This is the batch file
  1083.   the front end should execute when a mailer is detected on the remote end.
  1084.  
  1085. 5.6.0   CALLSEND.BAT
  1086.   Description:  This is the batch file nodes should execute when they wish
  1087.   to call their hub and 'do a mail run'.  The callsend batch file is
  1088.   similar to the EV_NODE.BAT file, but it does not restart the BBS.
  1089.  
  1090. 5.7.0   BUILD.BAT SystemId
  1091.   Description: This batch file is used by a hub system to build packets for
  1092.   all nodes connected.  In the DC_HUB.BAT batch file, a build is performed
  1093.   prior to waiting for node callers and after every node has connected.
  1094.   This type of operation can by time consuming depending on the number of
  1095.   nodes attached to the hub.  The build sections of the DC_HUB.BAT and
  1096.   AC_HUB.BAT are documented.  If processing time becomes a concern the
  1097.   build sections of these two batch files should be commented out and the
  1098.   BUILD.BAT file should be executed at specific times throughout the day.
  1099.  
  1100.   Parameters:
  1101.  
  1102.   SystemId - the hub system id
  1103.  
  1104. 5.8.0   PACKET.BAT SystemId RemoteId [PhoneNumber]
  1105.   Description: Packet allows a sysop to create or add to a packet for a
  1106.   node or a hub.  This batch file is useful to create or initialize a
  1107.   packet for a newly connected node.
  1108.  
  1109.   Parameters:
  1110.  
  1111.   SystemId - The local system id
  1112.  
  1113.   RemoteId - The remote system id, the system for which the packet will be
  1114.   build.
  1115.  
  1116.   PhoneNumber - The phone number of the Remote system if the remote system
  1117.   is a hub.
  1118.  
  1119.  
  1120.                  (c) 1989, 1990, 1991 by Code Masters, Inc.
  1121.                                 - Page 16 -
  1122.  
  1123.  
  1124. CMI HyperMail Documentation
  1125. Version 1.8 GR (General Release) !ShareWare!
  1126.  
  1127.   Example:
  1128.  
  1129.     PACKET CIS TECHNOID 222-1234
  1130.  
  1131.       Creates or adds to the TECHNOID packet.  TECHNOID is the hub in this
  1132.       case and CIS is the node.
  1133.  
  1134.     PAKCET TECHNOID CIS
  1135.  
  1136.       Creates or adds to the CIS packet.  CIS is the node in this case and
  1137.       TECHNOID is the hub.
  1138.  
  1139. 6.0.0   System Control File Reference
  1140.  
  1141. 6.1.0   NETMAIL.SYS
  1142.   Description:  This file is the central control file for the HyperMail
  1143.   system.  MAKESYS.EXE creates this file.  NETMAIL.SYS is the default name
  1144.   for the system control file.
  1145.  
  1146. 6.1.2   NETMAIL.LOG
  1147.   Description:  This is the log file for all system activity.  This file
  1148.   can grow large and should be purged on a regular basis.  NETMAIL.LOG is
  1149.   the default name for the log file and can be altered by using an
  1150.   environment variable.
  1151.  
  1152. 6.1.3   $SYSTEM$.PWD
  1153.   Description:  This is a system control file used for internal use.  It
  1154.   should not be deleted or altered.
  1155.  
  1156. 6.1.4   $EMAIL and $EMAIL.NDX
  1157.   Description:  These files store the system message base.  They are
  1158.   not used by the system as of version 1.8.
  1159.  
  1160. 6.1.5   CRC and CRC.IX
  1161.   Description:  These files store message CRC's for all extracted and
  1162.  inserted messages.  This file should never be deleted or modified.  If the
  1163.  CRC data base becomes too large for system constraints, use TRIMCRC.EXE to
  1164.  pack the CRC data base.
  1165.  
  1166. 6.1.6   SystemId.SYS
  1167.   Description:  These files (one for every node and hub attached to a
  1168.   system) record a pointer variable for system purposes.  This pointer
  1169.   variable is the last generation of MP??????.PKT file added to a systems
  1170.   archive.
  1171.  
  1172. 7.0.0   Environment Variables
  1173.   LOGFILE=FileName - Have programs write to different log files
  1174.  
  1175.   SYSTEM=FileName - Have programs write to different NETMAIL.SYS files
  1176.  
  1177.   CONFIG=FileName - Have programs read different configuration files
  1178.  
  1179.   BAUD=xxx - Only callers that have a connect BPS rate GREATER than or
  1180.   equal to xxx will be allowed into the system by HUBCOMM.EXE.
  1181.  
  1182.  
  1183.  
  1184.  
  1185.  
  1186.                  (c) 1989, 1990, 1991 by Code Masters, Inc.
  1187.                                 - Page 17 -
  1188.  
  1189.  
  1190. CMI HyperMail Documentation
  1191. Version 1.8 GR (General Release) !ShareWare!
  1192.  
  1193. Example:  Have MSGTUILE.EXE write to a different log file.
  1194.  
  1195.         SET LOGFILE=MSG.LOG
  1196.         MSGUTIL /E
  1197.         SET LOGFILE=
  1198.  
  1199. 8.0.0   Required third party programs
  1200. The HyperMail system is an integrated mail network package.  To maintain
  1201. flexibility and modularity the HyperMail system uses external protocols for
  1202. transferring files and external compression programs for efficiency.  The
  1203. recommended standards are presented in the next section.
  1204.  
  1205. 8.1.0   DSZ
  1206.   The HyperMail system uses DSZ.EXE or DSZ.COM by Omen Technologies Inc.
  1207.   for transferring files between systems.
  1208.  
  1209. 8.2.0   PKZIP
  1210.   The HyperMail system uses PKZIP.EXE and PKUNZIP.EXE by PKWARE Inc. for
  1211.   compression of message files.
  1212.  
  1213. 9.0.0   Conclusion
  1214.  
  1215. HyperMail is the easiest Networking mail package to install, hands down.
  1216. The maintenance and system operator duties are kept to a minimum by the
  1217. build in intelligence and modularity of the system.  HyperMail runs by
  1218. itself which allow operators more time for meaningful activities.
  1219.  
  1220. 9.1.0   Registration Information
  1221.  
  1222. In order to run HyperMail it is necessary to obtain a registration number
  1223. and a registration name.  When you install HyperMail the Installation Tool
  1224. will generate a registration number based on your BBS name.
  1225.  
  1226. 9.2.0   Disclaimer
  1227.  
  1228. Code Masters make no warranty of any kind, express or implied, including
  1229. without limitation, any warranties of merchantability and/or fitness for a
  1230. particular purpose.  Code Masters shall not be liable for any damages,
  1231. whether direct, indirect, special or consequential arising from a failure
  1232. of this program to operate in the manner desired by the user.  Code Masters
  1233. shall not be liable for any damage to data or property which may be caused
  1234. directly or indirectly by the use of this package.
  1235.  
  1236. IN NO EVENT WILL CODE MASTERS BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING
  1237. ANY LOST PROFITS, LOST SAVINGS OR OTHER INCIDENTAL OR CONSEQUENTIAL DAMAGES
  1238. ARISING OUT OF YOUR USE OR INABILITY TO USE THE PACKAGE, OR FOR ANY CLAIM
  1239. BY ANY OTHER PARTY.
  1240.  
  1241.  
  1242.  
  1243.  
  1244.  
  1245.  
  1246.  
  1247.  
  1248.  
  1249.  
  1250.  
  1251.  
  1252.                  (c) 1989, 1990, 1991 by Code Masters, Inc.
  1253.                                 - Page 18 -
  1254.  
  1255.  
  1256. CMI HyperMail Documentation
  1257. Version 1.8 GR (General Release) !ShareWare!
  1258.  
  1259. 9.3.0   Where to get more information
  1260.  
  1261. Support for HyperMail owners is available 24 hours a day via a 2 node
  1262. support Bulletin Board.  Questions, comments and suggestions are
  1263. encouraged.
  1264.  
  1265. TechnoBabble BBS
  1266. (602) 650-1595
  1267.  
  1268. Other points of information:
  1269.  
  1270. David Cantere, HyperLink National Hub
  1271. Technoids Anonomous BBS, Phoenix AZ
  1272. (602) 786-9131 1200/2400/9600 - USR HST 14.4
  1273. (602) 899-4876 1200/2400 - Hayes
  1274. (602) 899-5317 Voice
  1275.  
  1276.  
  1277.  
  1278.  
  1279.  
  1280.  
  1281.  
  1282.  
  1283.  
  1284.  
  1285.  
  1286.  
  1287.  
  1288.  
  1289.  
  1290.  
  1291.  
  1292.  
  1293.  
  1294.  
  1295.  
  1296.  
  1297.  
  1298.  
  1299.  
  1300.  
  1301.  
  1302.  
  1303.  
  1304.  
  1305.  
  1306.  
  1307.  
  1308.  
  1309.  
  1310.  
  1311.  
  1312.  
  1313.  
  1314.  
  1315.  
  1316.  
  1317.  
  1318.                  (c) 1989, 1990, 1991 by Code Masters, Inc.
  1319.                                 - Page 19 -
  1320.  
  1321.  
  1322. CMI HyperMail Documentation
  1323. Version 1.8 GR (General Release) !ShareWare!
  1324.  
  1325. Appendix A -Example: Steps to set up a 3 node network.
  1326.  
  1327. This appendix will describe the steps in detail required to setup a sample
  1328. 3 node HyperMail network.
  1329.  
  1330. Step 1: Define the systems: Who will be the Hub?  Who will be the node?
  1331.  
  1332. Define the system id's.  The Hub will be named CENTRAL.  There are two
  1333. nodes attached to CENTRAL, one called LEFT and one called RIGHT.  The
  1334. system id's are arbitrary as long as they are unique.
  1335.  
  1336. In this sample system we will define on hub CENTRAL and two nodes LEFT and
  1337. RIGHT.  This graph represents the network typlology:
  1338.  
  1339.                              CENTRAL
  1340.                             /       \
  1341.                           /           \
  1342.                         /               \
  1343.                      LEFT              RIGHT
  1344.  
  1345.  
  1346. Step 2: Install HyperMail as defined in the installation part of the
  1347.         manual.  Now that the systems have been defined all systems should
  1348.         install HyperMail.
  1349.  
  1350. Step 3: The Hub System Operator decides on what conferences are networked.
  1351.  
  1352. CENTRAL must decide which message areas will be on the network.  Currently
  1353. CENTRAL has 5 message areas defined:
  1354.  
  1355.     0  Main Board (Not allowed to echo)
  1356.     1  Technical
  1357.     2  Sysops
  1358.     3  Race Cars
  1359.     4  Networking
  1360.     5  Unix
  1361.  
  1362. The CENTRAL system operator decides to 'echo' or network 4 conferences:
  1363.     1  Technical
  1364.     2  Sysops
  1365.     4  Networking
  1366.     5  Unix
  1367.  
  1368. The System Operator of CENTRAL must use ProSM (supplied with ProDOOR) to
  1369. change the ECHO conference flag for each of the network echos.  This step
  1370. must be done or no messages will be echoed to the nodes.
  1371.  
  1372. The conference list for CENTRAL might now read:
  1373.  
  1374.     0  Main Board (Not allowed to echo)
  1375.     1  Technical    (NETWORKED)
  1376.     2  Sysops       (NETWORKED)
  1377.     3  Race Cars
  1378.     4  Networking   (NETWORKED)
  1379.     5  Unix         (NETWORKED)
  1380.  
  1381. Describing the conferences as being 'networked' or local allows the node
  1382. system operators to choose which conferences they can echo.
  1383.  
  1384.                  (c) 1989, 1990, 1991 by Code Masters, Inc.
  1385.                                 - Page 20 -
  1386.  
  1387.  
  1388. CMI HyperMail Documentation
  1389. Version 1.8 GR (General Release) !ShareWare!
  1390.  
  1391. Step 4: Nodes should create conference request files
  1392.  
  1393. LEFT has decided to echo conferences 1 and 2 from CENTRAL.  The LEFT system
  1394. operator must create conferences using ProSM for these new message areas.
  1395. The ECHO flag must be set for each conference that is networked.
  1396.  
  1397. LEFT has now updated his conference list:
  1398.  
  1399.     0  Main Board
  1400.     1  Hardware Store
  1401.     2  Technical       (NETWORKED)
  1402.     3  Guns
  1403.     4  Sysops          (NETWORKED)
  1404.  
  1405. LEFT must create a conference request file: CENTRAL.HUB and send this file
  1406. to CENTRAL.  The configuration is explained in the configuration section of
  1407. the manual.  Here is what the configuration file lookes like:
  1408.  
  1409.      PASSWORD
  1410.      2 1
  1411.      4 2
  1412.  
  1413. LEFT sends the CENTRAL.HUB file to CENTRAL and then copies CENTRAL.HUB to
  1414. CENTRAL.NEW.  Any additions or changes are made to the CENTRAL.NEW file.
  1415.  
  1416. The CENTRAL sysop receives the CENTRAL.HUB file and renames it to LEFT.NOD,
  1417. places it in the mail directory and executes the following programs:
  1418.  
  1419.   MAKESYS CENTRAL LEFT
  1420.   UPDATE
  1421.  
  1422. LEFT now executes the following programs in this sequence:
  1423.  
  1424.   MAKESYS LEFT CENTRAL PhoneNumber
  1425.   UPDATE
  1426.  
  1427.   - A pointer file CENTRAL.PTR has now been created for node LEFT
  1428.  
  1429. RIGHT has decided to echo conferences 1,2,4, AND 5 from CENTRAL.  The RIGHT
  1430. system operator must create conferences using ProSM for these new message
  1431. areas.  The ECHO flag must be set for each conference that is networked.
  1432.  
  1433. RIGHT has now updated his conference list:
  1434.  
  1435.     0  Main Board
  1436.     1  Unix            (NETWORKED)
  1437.     2  Technical       (NETWORKED)
  1438.     3  Sysops          (NETWORKED)
  1439.     4  Networking      (NETWORKED)
  1440.  
  1441.  
  1442.  
  1443.  
  1444.  
  1445.  
  1446.  
  1447.  
  1448.  
  1449.  
  1450.                  (c) 1989, 1990, 1991 by Code Masters, Inc.
  1451.                                 - Page 21 -
  1452.  
  1453.  
  1454. CMI HyperMail Documentation
  1455. Version 1.8 GR (General Release) !ShareWare!
  1456.  
  1457. RIGHT must create a conference request file: CENTRAL.HUB and send this file
  1458. to CENTRAL.  The configuration is explained in the configuration section of
  1459. the manual.  Here is what the configuration file lookes like:
  1460.  
  1461.      PASSWORD
  1462.      1 5
  1463.      2 1
  1464.      3 2
  1465.      4 4
  1466.  
  1467. RIGHT sends the CENTRAL.HUB file to CENTRAL and then copies CENTRAL.HUB to
  1468. CENTRAL.NEW.  Any additions or changes are made to the CENTRAL.NEW file.
  1469.  
  1470. The CENTRAL sysop receives the CENTRAL.HUB file and renames it to
  1471. RIGHT.NOD, places it in the mail directory and executes the following
  1472. programs:
  1473.  
  1474.   MAKESYS CENTRAL LEFT
  1475.   UPDATE
  1476.  
  1477. RIGHT executes the following programs in this sequence:
  1478.  
  1479.   MAKESYS RIGHT CENTRAL PhoneNumber
  1480.   UPDATE
  1481.  
  1482.   - A pointer file CENTRAL.PTR has now been created for node RIGHT.
  1483.  
  1484. Step 5: Setup a mail hour and the system events.
  1485.  
  1486. The CENTRAL system operator sets aside the time from 1:00 am to 2:00 am for
  1487. mail processing.  He configures his BBS software to execute EV_HUB.BAT at
  1488. 1:00 am.
  1489.  
  1490. The LEFT system operator is decides to call CENTRAL at 1:10 am.  He
  1491. configures his BBS software to execute EV_NODE.BAT at 1:10 am.
  1492.  
  1493. The RIGHT system operator decides to call CENTRAL at 1:40 am.  He
  1494. configures his BBS software to execute EV_NODE.BAT at 1:40 am.
  1495.  
  1496. Step 6: Test the setup.
  1497.  
  1498. At an agreed time all system operators agree to conference call each other.
  1499. CENTRAL executes EV_HUB.BAT.  LEFT now executes EV_NODE.BAT and trys to
  1500. connect with CENTRAL.  After LEFT has successfully completed his mail run,
  1501. RIGHT now executes EV_NODE.BAT and trys to connect with CENTRAL.
  1502.  
  1503. Step 7: Help!
  1504.  
  1505. If any errors occur during the connection process, double check the
  1506. existence of the LEFT.NOD and RIGHT.NOD files on CENTRAL and the
  1507. CENTRAL.HUB files on LEFT and RIGHT.
  1508.  
  1509. Be sure the passwords match and the files are named according to the
  1510. convention as described.  If problems persist consult contact Code Masters
  1511. at the support number listed in the "Where to get more help section".
  1512.  
  1513.  
  1514.  
  1515.  
  1516.                  (c) 1989, 1990, 1991 by Code Masters, Inc.
  1517.                                 - Page 22 -
  1518.  
  1519.  
  1520. CMI HyperMail Documentation
  1521. Version 1.8 GR (General Release) !ShareWare!
  1522.  
  1523. Appendix B - Using PCBoard as a front end.
  1524.  
  1525. NODECOMM.EXE has the ability to send a stream of text to an answering
  1526. system using the /F:FileName parameter.  Included is the file MAILRUN.TXT
  1527. which can be used as the FileName parameter (i.e. /F:MAILRUN.TXT).   Using
  1528. this feature NODECOMM.EXE can 'auto logon' to PCBoard, then PCBoard will
  1529. automatically open a door based on the callers security.
  1530.  
  1531. Below is the MAILRUN.TXT file:
  1532.  
  1533. N Q^NET MAIL MAILRUN^
  1534.  
  1535. Create a user called NET MAIL with the password MAILRUN and assign a
  1536. security level.  Configure the DOORS.LST file to automatically execute the
  1537. AC_HUB.BAT file when a caller of this security is detected.
  1538.  
  1539. This will work for ANY number of nodes that call the system.  They can use
  1540. the same logon id and password.  HyperMail will identify each system when
  1541. they call.
  1542.  
  1543.  
  1544.  
  1545.  
  1546.  
  1547.  
  1548.  
  1549.  
  1550.  
  1551.  
  1552.  
  1553.  
  1554.  
  1555.  
  1556.  
  1557.  
  1558.  
  1559.  
  1560.  
  1561.  
  1562.  
  1563.  
  1564.  
  1565.  
  1566.  
  1567.  
  1568.  
  1569.  
  1570.  
  1571.  
  1572.  
  1573.  
  1574.  
  1575.  
  1576.  
  1577.  
  1578.  
  1579.  
  1580.  
  1581.  
  1582.                  (c) 1989, 1990, 1991 by Code Masters, Inc.
  1583.                                 - Page 23 -
  1584.  
  1585.  
  1586. CMI HyperMail Documentation
  1587. Version 1.8 GR (General Release) !ShareWare!
  1588.  
  1589. Appendix C - Upgrading from a previous version of HyperMail
  1590.  
  1591. Whenever a new version of HyperMail is installed it is essential the
  1592. installation program be executed.  This ensures the proper configuration
  1593. files and batch files are created in accordance with the supported version.
  1594.  
  1595.  
  1596.  
  1597.  
  1598.  
  1599.  
  1600.  
  1601.  
  1602.  
  1603.  
  1604.  
  1605.  
  1606.  
  1607.  
  1608.  
  1609.  
  1610.  
  1611.  
  1612.  
  1613.  
  1614.  
  1615.  
  1616.  
  1617.  
  1618.  
  1619.  
  1620.  
  1621.  
  1622.  
  1623.  
  1624.  
  1625.  
  1626.  
  1627.  
  1628.  
  1629.  
  1630.  
  1631.  
  1632.  
  1633.  
  1634.  
  1635.  
  1636.  
  1637.  
  1638.  
  1639.  
  1640.  
  1641.  
  1642.  
  1643.  
  1644.  
  1645.  
  1646.  
  1647.  
  1648.                  (c) 1989, 1990, 1991 by Code Masters, Inc.
  1649.                                 - Page 24 -
  1650.  
  1651.  
  1652. CMI HyperMail Documentation
  1653. Version 1.8 GR (General Release) !ShareWare!
  1654.  
  1655. ┌─────────────────────────────────────────────────────────┐
  1656. │    C M I   H y p e r M a i l   O r d e r   F o r m      ├─┐
  1657. └─┬───────────────────────────────────────────────────────┘ │
  1658.   └─────────────────────────────────────────────────────────┘
  1659. =============================================================
  1660. Make Checks payable to:  Andrew Woodward
  1661.                Address:  PO Box 24991
  1662.                          Tempe, AZ 85285-4991
  1663. =============================================================
  1664.  
  1665. Your Name        ____________________________________________
  1666.  
  1667. Address          ____________________________________________
  1668.  
  1669. City, State Zip  ____________________________________________
  1670.  
  1671. Voice Phone      ____________________________________________
  1672.  
  1673.  ** Be specific when listing your BBS name.  It is your registration key.
  1674.     Uppercase and lower case letters will generate a different serial
  1675.     number.
  1676.  
  1677. BBS Name                 ____________________________________________
  1678.  
  1679. BBS Phone                ____________________________________________
  1680.  
  1681. HyperMail System Id      ┌─┬─┬─┬─┬─┬─┬─┬─┐
  1682. Valid DOS FileName:      │ │ │ │ │ │ │ │ │
  1683. (8 characters or less)   └─┴─┴─┴─┴─┴─┴─┴─┘
  1684.  
  1685. ┌───────────────────────┬──────────┬───────────┬────────────┐
  1686. │                       │   Price  │ Quantity  │ Totals     │
  1687. ├───────────────────────┼──────────┼───────────┼────────────┤
  1688. │ HyperMail Package     │  $50.00  │           │            │
  1689. └───────────────────────┴──────────┴───────────┼────────────┤
  1690.                            Amount  Enclosed   $│            │
  1691.                                                └────────────┘
  1692.  
  1693.  
  1694.  
  1695. Thanks!
  1696.  
  1697.  
  1698.  
  1699.  
  1700.  
  1701.  
  1702.  
  1703.  
  1704.  
  1705.  
  1706.  
  1707.  
  1708.  
  1709.  
  1710.  
  1711.  
  1712.  
  1713.  
  1714.                  (c) 1989, 1990, 1991 by Code Masters, Inc.
  1715.                                 - Page 25 -
  1716.  
  1717.